<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkPlug</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="prev" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="next" href="GtkSocket.html" title="GtkSocket">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="PlugSocket.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="PlugSocket.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
<td><a accesskey="n" href="GtkSocket.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkPlug.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GtkPlug.description" class="shortcut">Description</a>
                   | 
                  <a href="#GtkPlug.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GtkPlug.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#GtkPlug.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#GtkPlug.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkPlug"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkPlug.top_of_page"></a>GtkPlug</span></h2>
<p>GtkPlug — Toplevel for embedding into other processes</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkPlug.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gtk/gtk.h&gt;

struct              <a class="link" href="GtkPlug.html#GtkPlug-struct" title="struct GtkPlug">GtkPlug</a>;
<span class="returnvalue">void</span>                <a class="link" href="GtkPlug.html#gtk-plug-construct" title="gtk_plug_construct ()">gtk_plug_construct</a>                  (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkPlug.html#gtk-plug-construct-for-display" title="gtk_plug_construct_for_display ()">gtk_plug_construct_for_display</a>      (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkPlug.html#gtk-plug-new" title="gtk_plug_new ()">gtk_plug_new</a>                        (<em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkPlug.html#gtk-plug-new-for-display" title="gtk_plug_new_for_display ()">gtk_plug_new_for_display</a>            (<em class="parameter"><code><a href="../gdk/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);
<a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="returnvalue">GdkNativeWindow</span></a>     <a class="link" href="GtkPlug.html#gtk-plug-get-id" title="gtk_plug_get_id ()">gtk_plug_get_id</a>                     (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkPlug.html#gtk-plug-get-embedded" title="gtk_plug_get_embedded ()">gtk_plug_get_embedded</a>               (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);
<a href="../gdk/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *         <a class="link" href="GtkPlug.html#gtk-plug-get-socket-window" title="gtk_plug_get_socket_window ()">gtk_plug_get_socket_window</a>          (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkPlug.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
                     +----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
                           +----<a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
                                 +----<a class="link" href="GtkWindow.html" title="GtkWindow">GtkWindow</a>
                                       +----GtkPlug
</pre>
</div>
<div class="refsect1">
<a name="GtkPlug.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkPlug implements
 AtkImplementorIface and  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkPlug.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GtkPlug.html#GtkPlug--embedded" title='The "embedded" property'>embedded</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
  "<a class="link" href="GtkPlug.html#GtkPlug--socket-window" title='The "socket-window" property'>socket-window</a>"            <a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a>*            : Read
</pre>
</div>
<div class="refsect1">
<a name="GtkPlug.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GtkPlug.html#GtkPlug-embedded" title='The "embedded" signal'>embedded</a>"                                       : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GtkPlug.description"></a><h2>Description</h2>
<p>
Together with <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>, <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> provides the ability
to embed widgets from one process into another process
in a fashion that is transparent to the user. One
process creates a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget and passes the
ID of that widget's window to the other process,
which then creates a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> with that window ID.
Any widgets contained in the <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> then will appear
inside the first application's window.
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
The <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> and <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widgets are currently not available
on all platforms supported by GTK+.
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="GtkPlug.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkPlug-struct"></a><h3>struct GtkPlug</h3>
<pre class="programlisting">struct GtkPlug;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-construct"></a><h3>gtk_plug_construct ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_plug_construct                  (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);</pre>
<p>
Finish the initialization of <em class="parameter"><code>plug</code></em> for a given <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by
<em class="parameter"><code>socket_id</code></em>. This function will generally only be used by classes deriving from <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
<td>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>socket_id</code></em> :</span></p></td>
<td>the XID of the socket's window.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-construct-for-display"></a><h3>gtk_plug_construct_for_display ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_plug_construct_for_display      (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);</pre>
<p>
Finish the initialization of <em class="parameter"><code>plug</code></em> for a given <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by
<em class="parameter"><code>socket_id</code></em> which is currently displayed on <em class="parameter"><code>display</code></em>.
This function will generally only be used by classes deriving from <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
<td>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
<td>the <a href="../gdk/GdkDisplay.html"><span class="type">GdkDisplay</span></a> associated with <em class="parameter"><code>socket_id</code></em>'s
<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>socket_id</code></em> :</span></p></td>
<td>the XID of the socket's window.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-new"></a><h3>gtk_plug_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_plug_new                        (<em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);</pre>
<p>
Creates a new plug widget inside the <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified
by <em class="parameter"><code>socket_id</code></em>. If <em class="parameter"><code>socket_id</code></em> is 0, the plug is left "unplugged" and
can later be plugged into a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> by  <a class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()"><code class="function">gtk_socket_add_id()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>socket_id</code></em> :</span></p></td>
<td>the window ID of the socket, or 0.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-new-for-display"></a><h3>gtk_plug_new_for_display ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_plug_new_for_display            (<em class="parameter"><code><a href="../gdk/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="type">GdkNativeWindow</span></a> socket_id</code></em>);</pre>
<p>
Create a new plug widget inside the <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by socket_id.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td>
<td>the <a href="../gdk/GdkDisplay.html"><span class="type">GdkDisplay</span></a> on which <em class="parameter"><code>socket_id</code></em> is displayed</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>socket_id</code></em> :</span></p></td>
<td>the XID of the socket's window.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-get-id"></a><h3>gtk_plug_get_id ()</h3>
<pre class="programlisting"><a href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"><span class="returnvalue">GdkNativeWindow</span></a>     gtk_plug_get_id                     (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);</pre>
<p>
Gets the window ID of a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget, which can then
be used to embed this window inside another window, for
instance with <a class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()"><code class="function">gtk_socket_add_id()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
<td>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the window ID for the plug</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-get-embedded"></a><h3>gtk_plug_get_embedded ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_plug_get_embedded               (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);</pre>
<p>
Determines whether the plug is embedded in a socket.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
<td>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the plug is embedded in a socket</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-get-socket-window"></a><h3>gtk_plug_get_socket_window ()</h3>
<pre class="programlisting"><a href="../gdk/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *         gtk_plug_get_socket_window          (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);</pre>
<p>
Retrieves the socket the plug is embedded in.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
<td>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the window of the socket, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.14</p>
</div>
</div>
<div class="refsect1">
<a name="GtkPlug.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkPlug--embedded"></a><h3>The <code class="literal">"embedded"</code> property</h3>
<pre class="programlisting">  "embedded"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
<p>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the plug is embedded in a socket.
</p>
<p>Default value: FALSE</p>
<p class="since">Since 2.12</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlug--socket-window"></a><h3>The <code class="literal">"socket-window"</code> property</h3>
<pre class="programlisting">  "socket-window"            <a href="../gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a>*            : Read</pre>
<p>
The window of the socket the plug is embedded in.
</p>
<p class="since">Since 2.14</p>
</div>
</div>
<div class="refsect1">
<a name="GtkPlug.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkPlug-embedded"></a><h3>The <code class="literal">"embedded"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
Gets emitted when the plug becomes embedded in a socket.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td>
<td>the object on which the signal was emitted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GtkPlug.see-also"></a><h2>See Also</h2>
<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>